Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix some docstring issues affecting rendering #1739

Merged
merged 4 commits into from
Feb 20, 2024
Merged

fix some docstring issues affecting rendering #1739

merged 4 commits into from
Feb 20, 2024

Conversation

jackgerrits
Copy link
Member

@jackgerrits jackgerrits commented Feb 20, 2024 •
edited
Loading

Why are these changes needed?

Related issue number

Closes #1731

Checks

@skzhang1 skzhang1 self-requested a review February 20, 2024 20:15
@codecov-commenter
Copy link

codecov-commenter commented Feb 20, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2750391) 39.33% compared to head (5d47cb5) 51.16%.

Additional details and impacted files 
@@             Coverage Diff             @@
##             main    #1739       +/-   ##
===========================================
+ Coverage   39.33%   51.16%   +11.82%     
===========================================
  Files          57       57               
  Lines        6096     6096               
  Branches     1365     1484      +119     
===========================================
+ Hits         2398     3119      +721     
+ Misses       3502     2726      -776     
- Partials      196      251       +55
Flag Coverage Δ
unittests 51.08% <ø> (+11.74%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

skzhang1
skzhang1 suggested changes Feb 20, 2024
View reviewed changes
Copy link
Collaborator

@skzhang1 skzhang1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2024-02-20 at 15 49 57

@jackgerrits
Copy link
Member Author

Turns out the rendering issues are due to a bug in pydoc-markdown. Here's the fix: NiklasRosenstein/pydoc-markdown#317

The mitigation is also for us to set escape_html_in_docstring to false.

@jackgerrits
Copy link
Member Author

It turns out the `` was a red herring, so let me revert that change to avoid confusion

@sonichi sonichi added this pull request to the merge queue Feb 20, 2024
Merged via the queue into microsoft:main with commit d8a204a Feb 20, 2024
46 of 57 checks passed
whiskyboy pushed a commit to whiskyboy/autogen that referenced this pull request Apr 17, 2024
@jackgerrits
fix some docstring issues affecting rendering (microsoft#1739)
be71d7f 
* fix some docstring issues affecting rendering

* Update pydoc-markdown.yml

* undo double backtick

* Update compressible_agent.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gagb gagb gagb left review comments

@skzhang1 skzhang1 skzhang1 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docstring render error
5 participants
@jackgerrits @codecov-commenter @gagb @skzhang1 @sonichi